/*===========================================================================
  Copyright (C) 2014 by the Okapi Framework contributors
-----------------------------------------------------------------------------
  This library is free software; you can redistribute it and/or modify it 
  under the terms of the GNU Lesser General Public License as published by 
  the Free Software Foundation; either version 2.1 of the License, or (at 
  your option) any later version.

  This library is distributed in the hope that it will be useful, but 
  WITHOUT ANY WARRANTY; without even the implied warranty of 
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 
  General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License 
  along with this library; if not, write to the Free Software Foundation, 
  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

  See also the full LGPL text here: http://www.gnu.org/copyleft/lesser.html
===========================================================================*/

package net.sf.okapi.v2.common.om.impl;

import java.util.Iterator;
import java.util.LinkedHashMap;

import net.sf.okapi.v2.common.exceptions.InvalidParameterException;
import net.sf.okapi.v2.common.om.IDocument;
import net.sf.okapi.v2.common.om.ISubDocument;

/**
 * Implements {@link IDocument}.
 */
public class Document implements IDocument {
	
	private LinkedHashMap<String, ISubDocument> items;

	/**
	 * Creates a new {@link IDocument} object.
	 */
	public Document () {
		items = new LinkedHashMap<>(1);
	}

	@Override
	public Iterator<ISubDocument> iterator () {
		return items.values().iterator();
	}

	@Override
	public ISubDocument add (ISubDocument subDoc) {
		if ( subDoc == null ) {
			throw new InvalidParameterException("The sub-document must not be null.");
		}
		else if ( items.containsKey(subDoc.getId()) ) {
			throw new InvalidParameterException(String.format(
				"The sub-document's id '%s' is already used by an existing sub-document.", subDoc.getId()));
		}
		items.put(subDoc.getId(), subDoc);
		return subDoc;
	}

	@Override
	public ISubDocument get (String id) {
		return items.get(id);
	}

	@Override
	public void remove (String id) {
		items.remove(id);
	}

}
